/*
 * Copyright (c) 2018. Manuel D. Rossetti, rossetti@uark.edu
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package jsl.modeling.elements.spatial;

/**
 * Interface for a path finding algorithm
 *
 *
 */
public interface PathFinder {

    /**
     * Fills the supplied path parameter with the points on the path, not
     * including the starting location but including the goal location. The
     * coordinates should not be modified since they may be used inside other
     * objects (as an efficiency). The supplied path will be empty if no path is
     * found
     *
     * @param path A list to hold the points on the path
     * @param from
     * @param to
     */
    public void findPath(Path path, CoordinateIfc from, CoordinateIfc to);

    /**
     * Fills the supplied path parameter with the points on the path, not
     * including the starting location but including the goal location. The
     * supplied points should not be modified since they may be used inside
     * other objects (as an efficiency). The supplied path will be empty if no
     * path is found
     *
     * @param path A list to hold the points on the path
     * @param from
     * @param to
     */
    public void findPath(Path path, SpatialElementIfc from, SpatialElementIfc to);

}
